Class Objects.Static

Represents a static object in the game world.

Functions

Static:GetName() Get this static's unique string identifier.
Static:GetSlot() Get this static's slot ID.
Static:GetPosition() Get this static's world position.
Static:GetRotation() Get this static's world rotation.
Static:GetScale() Get this static's world scale.
Static:GetColor() Get this static's color.
Static:GetHP() Get this static's hit points.
Static:GetActive() Get this static's visibility status.
Static:GetCollidable() Get this static's collision status.
Static:GetSolid() Get this static's solid collision status.
Static:SetName(name) Set this static's unique identifier string.
Static:SetSlot(slotID) Set this static's slot ID.
Static:SetPosition(pos) Set this static's world position.
Static:SetRotation(rot) Set this static's rotation.
Static:SetScale(scale) Set this static's world scale.
Static:SetColor(color) Set this static's color.
Static:SetHP(hitPoints) Set this static's hit points.
Static:SetSolid(status) Set this static's solid collision status.
Static:SetCollidable(collidable) Set this static's collision status.
Static:Enable() Enable this static.
Static:Disable() Disable this static.
Static:Shatter() Shatter this static.


Functions

Static:GetName()
Get this static's unique string identifier.

Returns:

    string Name string.
Static:GetSlot()
Get this static's slot ID.

Returns:

    int Slot ID.
Static:GetPosition()
Get this static's world position.

Returns:

    Vec3 World position.
Static:GetRotation()
Get this static's world rotation.

Returns:

    Rotation World rotation.
Static:GetScale()
Get this static's world scale.

Returns:

    float World scale.
Static:GetColor()
Get this static's color.

Returns:

    Color Color.
Static:GetHP()
Get this static's hit points. Used only with shatterable statics.

Returns:

    int Hit points.
Static:GetActive()
Get this static's visibility status.

Returns:

    bool Status. true: visible, false: invisible
Static:GetCollidable()
Get this static's collision status.

Returns:

    bool Collision status. true: can be collided with, false: no collision
Static:GetSolid()
Get this static's solid collision status.

Returns:

    bool Solid Status. true: solid, false: soft
Static:SetName(name)
Set this static's unique identifier string.

Parameters:

Static:SetSlot(slotID)
Set this static's slot ID.

Parameters:

  • slotID int New slot ID.
Static:SetPosition(pos)
Set this static's world position.

Parameters:

  • pos Vec3 New world position.
Static:SetRotation(rot)
Set this static's rotation.

Parameters:

Static:SetScale(scale)
Set this static's world scale.

Parameters:

  • scale float New world scale.
Static:SetColor(color)
Set this static's color.

Parameters:

Static:SetHP(hitPoints)
Set this static's hit points. Used only with shatterable statics.

Parameters:

  • hitPoints int New hit points.
Static:SetSolid(status)
Set this static's solid collision status.

Parameters:

  • status bool New status. true: solid, false: soft
Static:SetCollidable(collidable)
Set this static's collision status.

Parameters:

  • collidable bool New collision status. true: can be collided with, false: no collision
Static:Enable()
Enable this static. Used when previously shattered disabled manually.
Static:Disable()
Disable this static.
Static:Shatter()
Shatter this static.
generated by TEN-LDoc (a fork of LDoc 1.4.6)